<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Arduino MIDI File Parser: src/RingBuffer.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Arduino MIDI File Parser
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">RingBuffer.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor">#include &lt;stdbool.h&gt;</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="preprocessor">#include &lt;string.h&gt;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#include &lt;assert.h&gt;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor">#define PEEK_MAX 80</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160; </div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="keyword">namespace </span>midi {</div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="classmidi_1_1RingBuffer.html">   16</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmidi_1_1RingBuffer.html">RingBuffer</a> {</div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;  <a class="code" href="classmidi_1_1RingBuffer.html">RingBuffer</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;  <a class="code" href="classmidi_1_1RingBuffer.html">RingBuffer</a>(<a class="code" href="classmidi_1_1RingBuffer.html">RingBuffer</a> &amp;t){</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;    _aucBuffer = <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;    reset();</div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;  }</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;  <a class="code" href="classmidi_1_1RingBuffer.html">RingBuffer</a>(<span class="keywordtype">int</span> <a class="code" href="classmidi_1_1RingBuffer.html#ad563dc1d6c0ca23612781d957c565b75">size</a>) {</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;    resize(<a class="code" href="classmidi_1_1RingBuffer.html#ad563dc1d6c0ca23612781d957c565b75">size</a>);</div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;    reset();</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;  }</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;  ~<a class="code" href="classmidi_1_1RingBuffer.html">RingBuffer</a>() { <span class="keywordflow">if</span> (_aucBuffer!=<span class="keyword">nullptr</span>)<span class="keyword">delete</span>[] _aucBuffer; }</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;  uint8_t read() {</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;    <span class="keywordflow">if</span> (isEmpty())</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;      <span class="keywordflow">return</span> -1;</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;    uint8_t value = _aucBuffer[_iTail];</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    _iTail = nextIndex(_iTail);</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    _numElems--;</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    <span class="keywordflow">return</span> value;</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;  }</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;  <span class="comment">// checks if the buffer is full</span></div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;  <span class="keywordtype">bool</span> isFull() { <span class="keywordflow">return</span> available() == max_size; }</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160; </div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;  <span class="keywordtype">bool</span> isEmpty() { <span class="keywordflow">return</span> available() == 0; }</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;  <span class="comment">// write add an entry to the buffer</span></div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;  <span class="keywordtype">bool</span> write(uint8_t data) {</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    <span class="keywordtype">bool</span> result = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    <span class="keywordflow">if</span> (!isFull()) {</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;      _aucBuffer[_iHead] = data;</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;      _iHead = nextIndex(_iHead);</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;      _numElems++;</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;      result = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    }</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    <span class="keywordflow">return</span> result;</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;  }</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;  <span class="keywordtype">int</span> write(<span class="keyword">const</span> uint8_t *data, <span class="keywordtype">size_t</span> len) {</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;    <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j = 0; j &lt; len; j++) {</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;      <span class="keywordflow">if</span> (!write(data[j])) {</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;        <span class="keywordflow">return</span> j;</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;      }</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    }</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    <span class="keywordflow">return</span> len;</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;  }</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;  <span class="comment">// clears the buffer</span></div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;  <span class="keywordtype">void</span> reset() {</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    _iHead = 0;</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    _iTail = 0;</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    _numElems = 0;</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;  }</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;  <span class="comment">// provides the number of entries that are available to read</span></div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;  <span class="keywordtype">int</span> available() { <span class="keywordflow">return</span> _numElems; }</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;  <span class="comment">// provides the number of entries that are available to write</span></div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;  <span class="keywordtype">int</span> availableForWrite() { <span class="keywordflow">return</span> (max_size - _numElems); }</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160; </div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;  <span class="keywordtype">void</span> resize(<span class="keywordtype">int</span> len) {</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    <span class="comment">// if no change: we can leave</span></div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    <span class="keywordflow">if</span> (this-&gt;max_size==len &amp;&amp; _aucBuffer!=<span class="keyword">nullptr</span>){</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;      <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;    }</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;    <span class="comment">// (re)allocate buffer</span></div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;    <span class="keywordflow">if</span> (_aucBuffer != <span class="keyword">nullptr</span>) {</div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;      <span class="keyword">delete</span>[] _aucBuffer;</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    }</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;    this-&gt;max_size = len;</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;    <span class="keywordflow">if</span> (len &gt; 0) {</div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;      _aucBuffer = <span class="keyword">new</span> uint8_t[max_size];</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;      assert(_aucBuffer != <span class="keyword">nullptr</span>);</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;    }</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;    reset();</div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;  }</div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160; </div>
<div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="classmidi_1_1RingBuffer.html#ad563dc1d6c0ca23612781d957c565b75">  100</a></span>&#160;  <span class="keywordtype">int</span> <a class="code" href="classmidi_1_1RingBuffer.html#ad563dc1d6c0ca23612781d957c565b75">size</a>() { <span class="keywordflow">return</span> max_size; }</div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160; </div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;  <span class="comment">// peeks the actual entry from the buffer</span></div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;  <span class="keywordtype">int</span> peek() {</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;    <span class="keywordflow">if</span> (isEmpty())</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;      <span class="keywordflow">return</span> -1;</div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160; </div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;    <span class="keywordflow">return</span> _aucBuffer[_iTail];</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;  }</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160; </div>
<div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="classmidi_1_1RingBuffer.html#afd6516031da0820106c6a348231f8e89">  111</a></span>&#160;  <span class="keywordtype">int</span> <a class="code" href="classmidi_1_1RingBuffer.html#afd6516031da0820106c6a348231f8e89">peek</a>(<span class="keywordtype">int</span> idx) {</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;    <span class="keywordflow">if</span> (idx &gt; available())</div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;      <span class="keywordflow">return</span> -1;</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;    <span class="keywordtype">int</span> tmp_tail = (_iTail + idx) % max_size;</div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;    <span class="keywordflow">return</span> _aucBuffer[tmp_tail];</div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;  }</div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160; </div>
<div class="line"><a name="l00119"></a><span class="lineno"><a class="line" href="classmidi_1_1RingBuffer.html#acf30e4b7de8425b0e3243f5220206f04">  119</a></span>&#160;  uint8_t *<a class="code" href="classmidi_1_1RingBuffer.html#acf30e4b7de8425b0e3243f5220206f04">peekStr</a>(<span class="keywordtype">int</span> idx, <span class="keywordtype">int</span> len) {</div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;    <span class="keywordflow">if</span> (len==0) <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;    <span class="keyword">static</span> uint8_t tmp_copy[PEEK_MAX];</div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;    assert(len &lt; PEEK_MAX);</div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;    assert(idx+len&lt;available());</div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;    memset(&amp;tmp_copy, 0, PEEK_MAX);</div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;    <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j = 0; j &lt; len; j++) {</div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;      tmp_copy[j] = peek(idx + j);</div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;    }</div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;    <span class="keywordflow">return</span> tmp_copy;</div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;  }</div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160; </div>
<div class="line"><a name="l00132"></a><span class="lineno"><a class="line" href="classmidi_1_1RingBuffer.html#a41bd5105a362763778d0a8e27d3bcf23">  132</a></span>&#160;  uint8_t <a class="code" href="classmidi_1_1RingBuffer.html#a41bd5105a362763778d0a8e27d3bcf23">operator[]</a>(<span class="keywordtype">int</span> idx) {</div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;    <span class="keywordtype">int</span> result = peek(idx);</div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;    assert(result!=-1);</div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;    <span class="keywordflow">return</span> result;</div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;  }</div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160; </div>
<div class="line"><a name="l00139"></a><span class="lineno"><a class="line" href="classmidi_1_1RingBuffer.html#a583861751422aa94cb45626fed086680">  139</a></span>&#160;  <span class="keywordtype">bool</span> <a class="code" href="classmidi_1_1RingBuffer.html#a583861751422aa94cb45626fed086680">equals</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *str) {</div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;    <span class="keywordtype">int</span> len = strlen(str);</div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;    <span class="keywordflow">return</span> strncmp(str, (<span class="keywordtype">char</span>*)<a class="code" href="classmidi_1_1RingBuffer.html#acf30e4b7de8425b0e3243f5220206f04">peekStr</a>(0, len), len) == 0;</div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;  }</div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160; </div>
<div class="line"><a name="l00145"></a><span class="lineno"><a class="line" href="classmidi_1_1RingBuffer.html#a49adea581748cecf92b1b3ac99812e69">  145</a></span>&#160;  <span class="keywordtype">void</span> <a class="code" href="classmidi_1_1RingBuffer.html#a49adea581748cecf92b1b3ac99812e69">consume</a>(<span class="keywordtype">int</span> offset) {</div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;    assert(available() &gt;= offset);</div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;    <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j = 0; j &lt; offset; j++) {</div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;      read();</div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;    }</div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;  }</div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160; </div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;  uint8_t *_aucBuffer = <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;  <span class="keywordtype">int</span> _iHead;</div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;  <span class="keywordtype">int</span> _iTail;</div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;  <span class="keywordtype">int</span> _numElems;</div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;  <span class="keywordtype">int</span> max_size = 0;</div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160; </div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;  <span class="keywordtype">int</span> nextIndex(<span class="keywordtype">int</span> index) { <span class="keywordflow">return</span> (uint32_t)(index + 1) % max_size; }</div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;};</div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160; </div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;} <span class="comment">// namespace</span></div>
<div class="ttc" id="aclassmidi_1_1RingBuffer_html"><div class="ttname"><a href="classmidi_1_1RingBuffer.html">midi::RingBuffer</a></div><div class="ttdoc">RingBuffer that supports extensive peek operations to access and compare the next values.</div><div class="ttdef"><b>Definition:</b> RingBuffer.h:16</div></div>
<div class="ttc" id="aclassmidi_1_1RingBuffer_html_a41bd5105a362763778d0a8e27d3bcf23"><div class="ttname"><a href="classmidi_1_1RingBuffer.html#a41bd5105a362763778d0a8e27d3bcf23">midi::RingBuffer::operator[]</a></div><div class="ttdeci">uint8_t operator[](int idx)</div><div class="ttdoc">alternaive syntax to peek(idx)</div><div class="ttdef"><b>Definition:</b> RingBuffer.h:132</div></div>
<div class="ttc" id="aclassmidi_1_1RingBuffer_html_a49adea581748cecf92b1b3ac99812e69"><div class="ttname"><a href="classmidi_1_1RingBuffer.html#a49adea581748cecf92b1b3ac99812e69">midi::RingBuffer::consume</a></div><div class="ttdeci">void consume(int offset)</div><div class="ttdoc">Removes the next n characters from the ringbuffer.</div><div class="ttdef"><b>Definition:</b> RingBuffer.h:145</div></div>
<div class="ttc" id="aclassmidi_1_1RingBuffer_html_a583861751422aa94cb45626fed086680"><div class="ttname"><a href="classmidi_1_1RingBuffer.html#a583861751422aa94cb45626fed086680">midi::RingBuffer::equals</a></div><div class="ttdeci">bool equals(const char *str)</div><div class="ttdoc">Compares the string with the current peek values.</div><div class="ttdef"><b>Definition:</b> RingBuffer.h:139</div></div>
<div class="ttc" id="aclassmidi_1_1RingBuffer_html_acf30e4b7de8425b0e3243f5220206f04"><div class="ttname"><a href="classmidi_1_1RingBuffer.html#acf30e4b7de8425b0e3243f5220206f04">midi::RingBuffer::peekStr</a></div><div class="ttdeci">uint8_t * peekStr(int idx, int len)</div><div class="ttdoc">returns a temporary copy of the requested bytes</div><div class="ttdef"><b>Definition:</b> RingBuffer.h:119</div></div>
<div class="ttc" id="aclassmidi_1_1RingBuffer_html_ad563dc1d6c0ca23612781d957c565b75"><div class="ttname"><a href="classmidi_1_1RingBuffer.html#ad563dc1d6c0ca23612781d957c565b75">midi::RingBuffer::size</a></div><div class="ttdeci">int size()</div><div class="ttdoc">Returns the maximum capacity of the buffer.</div><div class="ttdef"><b>Definition:</b> RingBuffer.h:100</div></div>
<div class="ttc" id="aclassmidi_1_1RingBuffer_html_afd6516031da0820106c6a348231f8e89"><div class="ttname"><a href="classmidi_1_1RingBuffer.html#afd6516031da0820106c6a348231f8e89">midi::RingBuffer::peek</a></div><div class="ttdeci">int peek(int idx)</div><div class="ttdoc">peeks the idx next entry from the buffer</div><div class="ttdef"><b>Definition:</b> RingBuffer.h:111</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
